Fzzy Config/me.fzzyhmstrs.fzzy_config.screen.widget/SuggestionBackedTextFieldWidget

SuggestionBackedTextFieldWidget

class SuggestionBackedTextFieldWidget(width: Int, height: Int, wrappedValue: Supplier<String>, choiceValidator: ChoiceValidator<String>, validator: EntryValidator<String>, applier: Consumer<String>, suggestionProvider: SuggestionBackedTextFieldWidget.SuggestionProvider, closePopup: Boolean) : ValidationBackedTextFieldWidget, SuggestionWindowProvider

A ValidationBackedTextFieldWidget that provides suggestions for string completion to the user

Author

fzzyhmstrs

Since

0.2.0

Parameters

width

Int - the width of the widget in pixels

height

Int - the height of the widget in pixels

wrappedValue

Supplier - supplies strings to the text field for display

choiceValidator

ChoiceValidator - additional choice validation, if any. Generally this can be ChoiceValidator.any

validator

EntryValidator - String validation provider see EntryValidator.Builder for more details on validation construction

applier

Consumer - accepts newly valid user inputs.

suggestionProvider

SuggestionProvider - provides the valid suggestions for the user

closePopup

Boolean - if true, this window will 'pop' the latest PopupWidget, if any.

Constructors

SuggestionBackedTextFieldWidget

constructor(width: Int, height: Int, wrappedValue: Supplier<String>, choiceValidator: ChoiceValidator<String>, validator: EntryValidator<String>, applier: Consumer<String>, suggestionProvider: SuggestionBackedTextFieldWidget.SuggestionProvider)

Types

SuggestionProvider

fun interface SuggestionProvider

Interface for providing suggestions into the widget based on current widget and validator state.

Properties

var active: Boolean

var focused: Boolean

var message: Text

var navigationOrder: Int

text

var text: String

visible

var visible: Boolean

var x: Int

var y: Int

Functions

addListener

open override fun addListener(listener: SuggestionWindowListener)

appendClickableNarrations

open override fun appendClickableNarrations(builder: NarrationMessageBuilder)

appendNarrations

override fun appendNarrations(builder: NarrationMessageBuilder)

appendValueNarrations

fun appendValueNarrations(builder: NarrationMessageBuilder)

charTyped

open override fun charTyped(chr: Char, modifiers: Int): Boolean

drawsBackground

open fun drawsBackground(): Boolean

eraseCharacters

open fun eraseCharacters(characterOffset: Int)

eraseCharactersTo

open fun eraseCharactersTo(position: Int)

eraseWords

open fun eraseWords(wordOffset: Int)

forEachChild

open override fun forEachChild(consumer: Consumer<ClickableWidget>)

getBottom

open fun getBottom(): Int

getCharacterX

open fun getCharacterX(index: Int): Int

getCursor

open fun getCursor(): Int

getFocusedPath

@Nullable

open fun getFocusedPath(): GuiNavigationPath?

getHeight

open override fun getHeight(): Int

getNavigationFocus

open override fun getNavigationFocus(): ScreenRect

getNavigationPath

@Nullable

open override fun getNavigationPath(navigation: GuiNavigation): GuiNavigationPath?

getRight

open fun getRight(): Int

getSelectedText

open fun getSelectedText(): String

getTooltip

@Nullable

open fun getTooltip(): Tooltip?

getType

open override fun getType(): Selectable.SelectionType

getValue

fun getValue(): String

getWidth

open override fun getWidth(): Int

getWordSkipPosition

open fun getWordSkipPosition(wordOffset: Int): Int

isActive

open fun isActive(): Boolean

isHovered

open fun isHovered(): Boolean

isMouseOver

open override fun isMouseOver(mouseX: Double, mouseY: Double): Boolean

isNarratable

open override fun isNarratable(): Boolean

isSelected

open fun isSelected(): Boolean

isVisible

open fun isVisible(): Boolean

keyPressed

open override fun keyPressed(keyCode: Int, scanCode: Int, modifiers: Int): Boolean

keyReleased

open fun keyReleased(keyCode: Int, scanCode: Int, modifiers: Int): Boolean

mouseClicked

open override fun mouseClicked(mouseX: Double, mouseY: Double, button: Int): Boolean

mouseDragged

open override fun mouseDragged(mouseX: Double, mouseY: Double, button: Int, deltaX: Double, deltaY: Double): Boolean

mouseMoved

open fun mouseMoved(mouseX: Double, mouseY: Double)

mouseReleased

open override fun mouseReleased(mouseX: Double, mouseY: Double, button: Int): Boolean

mouseScrolled

open override fun mouseScrolled(mouseX: Double, mouseY: Double, horizontalAmount: Double, verticalAmount: Double): Boolean

moveCursor

open fun moveCursor(offset: Int, shiftKeyPressed: Boolean)

onClick

open override fun onClick(mouseX: Double, mouseY: Double)

onRelease

open fun onRelease(mouseX: Double, mouseY: Double)

playDownSound

open override fun playDownSound(soundManager: SoundManager)

pushChanges

fun pushChanges()

Pushes changes stored in this widget into the linked applier. This is typically used to force immediate visual updates in the GUI.

render

override fun render(context: DrawContext, mouseX: Int, mouseY: Int, delta: Float)

renderWidget

open override fun renderWidget(context: DrawContext, mouseX: Int, mouseY: Int, delta: Float)

setAlpha

open fun setAlpha(alpha: Float)

setCursor

open fun setCursor(cursor: Int, shiftKeyPressed: Boolean)

setCursorToEnd

open fun setCursorToEnd(shiftKeyPressed: Boolean)

setCursorToStart

open fun setCursorToStart(shiftKeyPressed: Boolean)

setDimensions

open fun setDimensions(width: Int, height: Int)

setDimensionsAndPosition

open fun setDimensionsAndPosition(width: Int, height: Int, x: Int, y: Int)

setDrawsBackground

open fun setDrawsBackground(drawsBackground: Boolean)

setEditable

open fun setEditable(editable: Boolean)

setEditableColor

open fun setEditableColor(editableColor: Int)

setFocusUnlocked

open fun setFocusUnlocked(focusUnlocked: Boolean)

setHeight

open fun setHeight(height: Int)

setPlaceholder

open fun setPlaceholder(placeholder: Text)

setPosition

open fun setPosition(x: Int, y: Int)

setRenderTextProvider

open fun setRenderTextProvider(renderTextProvider: BiFunction<String, Int, OrderedText>)

setSelectionEnd

open fun setSelectionEnd(index: Int)

setSelectionStart

open fun setSelectionStart(cursor: Int)

setSuggestion

open fun setSuggestion(@Nullable suggestion: String?)

setTextPredicate

open fun setTextPredicate(textPredicate: Predicate<String>)

setTooltip

open fun setTooltip(@Nullable tooltip: Tooltip?)

setTooltipDelay

open fun setTooltipDelay(tooltipDelay: Duration)

setUneditableColor

open fun setUneditableColor(uneditableColor: Int)

setVisible

open fun setVisible(visible: Boolean)

setWidth

open fun setWidth(width: Int)

write

open fun write(text: String)